Skip to content

(feat) O3-4315: Add support for workspace-launcher rendering type #410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

(feat) O3-4315: Add support for workspace-launcher rendering type #410

wants to merge 13 commits into from

Conversation

@rdwaynedehoedt
Copy link

@rdwaynedehoedt rdwaynedehoedt commented Mar 1, 2025 •
edited by atlassian bot
Loading

Requirements

  • This PR has a title that briefly describes the work done including the ticket number. If there is a ticket, make sure your PR title includes a conventional commit label. See existing PR titles for inspiration.
  • My work conforms to the OpenMRS 3.0 Styleguide and design documentation.
  • My work includes tests or is validated by existing tests.

Summary

This PR implements the workspace-launcher rendering type for form questions as specified in O3-4315. The workspace-launcher allows form creators to add buttons that launch different workspaces or sub-forms within the OpenMRS application, enhancing clinical workflow integration.

The implementation includes:

  • A new workspace-launcher.component.tsx component with input fields for buttonLabel and workspaceName
  • Updates to the QuestionOptions interface in types.ts to include these new properties
  • Registration of the component in the inputs index and component map
  • Integration with the existing form builder architecture

This feature is part of the O3 Form Builder v3 epic (O3-1144).

Related Issue

https://openmrs.atlassian.net/browse/O3-4315

Other

The workspace-launcher rendering type follows the specified JSON structure:

"questionOptions": {
  "rendering": "workspace-launcher",
  "buttonLabel": " ",
  "workspaceName": ""
}

@rdwaynedehoedt
Copy link
Author

rdwaynedehoedt commented Mar 1, 2025

Hi @NethmiRodrigo , could you review this PR Thanks!

Bharath-K-Shetty
Bharath-K-Shetty suggested changes Mar 2, 2025
View reviewed changes
Copy link
Contributor

@Bharath-K-Shetty Bharath-K-Shetty left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rdwaynedehoedt Please add a video demonstrating that everything still behaves as expected & add unit test covering this change.

NethmiRodrigo
NethmiRodrigo requested changes Mar 7, 2025
View reviewed changes
Copy link
Collaborator

@NethmiRodrigo NethmiRodrigo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @rdwaynedehoedt! Good work! Please look at the comments and include a screenshot of the UI and how it works in the description. Its also preferred to add unit tests for new functionality, similar to how the other inputs do.

NethmiRodrigo
NethmiRodrigo requested changes Mar 14, 2025
View reviewed changes
Copy link
Collaborator

@NethmiRodrigo NethmiRodrigo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Almost there @rdwaynedehoedt! Some minor changes. Excellent test cases!

@rdwaynedehoedt
fix: improve workspace-launcher code quality - Update setState to use…
4f5d79d 
… callback pattern - Remove unnecessary test setup - Use userEvent instead of fireEvent in tests
@rdwaynedehoedt
Merge remote changes with translation updates
6e34072
@NethmiRodrigo NethmiRodrigo changed the title O3-4315 : Add support for workspace-launcher rendering type (feat) O3-4315: Add support for workspace-launcher rendering type Mar 17, 2025
NethmiRodrigo
NethmiRodrigo reviewed Mar 17, 2025
View reviewed changes
Copy link
Collaborator

@NethmiRodrigo NethmiRodrigo left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @rdwaynedehoedt! One last thing :)

...question/question-form/rendering-types/inputs/workspace-launcher/workspace-launcher.test.tsx
await user.clear(workspaceNameInput);
await user.type(workspaceNameInput, newValue);

expect(mockSetFormField).toHaveBeenCalled();
Copy link
Collaborator

@NethmiRodrigo NethmiRodrigo Mar 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is good to have, but we can make it a bit better by checking if it got called with the right object. Here's a place where you can use for guidance -

openmrs-esm-form-builder/src/components/interactive-builder/modals/question/question-form/question-types/inputs/obs/obs-type-question.test.tsx

Lines 115 to 129 in d80c228

// Gets all calls made to our mock function, the arguments from the first call and the first argument of the first call
const updateFn = mockSetFormField.mock.calls[0][0];
// Execute the update function with the previous state
const resultState = updateFn(formField);
// Check that the result has the expected values
expect(resultState).toEqual({
...formField,
datePickerFormat: 'calendar',
questionOptions: {
...formField.questionOptions,
concept: '456',
},
});

@NethmiRodrigo
Copy link
Collaborator

NethmiRodrigo commented Mar 27, 2025

Pinging @rdwaynedehoedt, are you stuck on any part of updating the tests, if so do let me know and I'll try to help out

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@NethmiRodrigo NethmiRodrigo NethmiRodrigo requested changes

+1 more reviewer

@Bharath-K-Shetty Bharath-K-Shetty Bharath-K-Shetty requested changes

Reviewers whose approvals may not affect merge requirements

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rdwaynedehoedt @NethmiRodrigo @Bharath-K-Shetty